home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 2003 August / MW 8 2003 CD1.iso / Inside Macworld / Product News / gimp-1.2.4.sit / gimp-1.2.4 / devel-docs / libgimp / sgml / gimppatterns.sgml < prev    next >
Encoding:
Text File  |  2003-05-20  |  7.0 KB  |  171 lines
  1. <refentry id="libgimp-gimppatterns" revision="19 Jan 2001">
  2. <refmeta>
  3. <refentrytitle>gimppatterns</refentrytitle>
  4. <manvolnum>3</manvolnum>
  5. <refmiscinfo>LIBGIMP Library</refmiscinfo>
  6. </refmeta>
  7.  
  8. <refnamediv>
  9. <refname>gimppatterns</refname><refpurpose></refpurpose>
  10. </refnamediv>
  11.  
  12. <refsynopsisdiv><title>Synopsis</title>
  13. <synopsis>
  14.  
  15.  
  16.  
  17. <link linkend="gchar">gchar</link>*      <link linkend="gimp-patterns-get-pattern-data">gimp_patterns_get_pattern_data</link>  (<link linkend="gchar">gchar</link> *name,
  18.                                              <link linkend="gint">gint</link> *width,
  19.                                              <link linkend="gint">gint</link> *height,
  20.                                              <link linkend="gint">gint</link> *mask_bpp,
  21.                                              <link linkend="gint">gint</link> *length,
  22.                                              <link linkend="guint8">guint8</link> **mask_data);
  23. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-patterns-popup">gimp_patterns_popup</link>             (<link linkend="gchar">gchar</link> *pattern_callback,
  24.                                              <link linkend="gchar">gchar</link> *popup_title,
  25.                                              <link linkend="gchar">gchar</link> *initial_pattern);
  26. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-patterns-close-popup">gimp_patterns_close_popup</link>       (<link linkend="gchar">gchar</link> *pattern_callback);
  27. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-patterns-set-popup">gimp_patterns_set_popup</link>         (<link linkend="gchar">gchar</link> *pattern_callback,
  28.                                              <link linkend="gchar">gchar</link> *pattern_name);
  29. </synopsis>
  30. </refsynopsisdiv>
  31.  
  32.  
  33.  
  34.  
  35.  
  36. <refsect1>
  37. <title>Description</title>
  38. <para>
  39.  
  40. </para>
  41. </refsect1>
  42.  
  43. <refsect1>
  44. <title>Details</title>
  45. <refsect2>
  46. <title><anchor id="gimp-patterns-get-pattern-data">gimp_patterns_get_pattern_data ()</title>
  47. <programlisting><link linkend="gchar">gchar</link>*      gimp_patterns_get_pattern_data  (<link linkend="gchar">gchar</link> *name,
  48.                                              <link linkend="gint">gint</link> *width,
  49.                                              <link linkend="gint">gint</link> *height,
  50.                                              <link linkend="gint">gint</link> *mask_bpp,
  51.                                              <link linkend="gint">gint</link> *length,
  52.                                              <link linkend="guint8">guint8</link> **mask_data);</programlisting>
  53. <para>
  54. Retrieve information about the currently active pattern (including
  55. data).
  56. </para>
  57. <para>
  58. This procedure retrieves information about the currently active
  59. pattern. This includes the pattern name, and the pattern extents
  60. (width and height). It also returns the pattern data.</para>
  61. <para>
  62.  
  63. </para><informaltable pgwide=1 frame="none" role="params">
  64. <tgroup cols="2">
  65. <colspec colwidth="2*">
  66. <colspec colwidth="8*">
  67. <tbody>
  68. <row><entry align="right"><parameter>name</parameter> :</entry>
  69. <entry> the pattern name (\"\" means current active pattern).
  70. </entry></row>
  71. <row><entry align="right"><parameter>width</parameter> :</entry>
  72. <entry> The pattern width.
  73. </entry></row>
  74. <row><entry align="right"><parameter>height</parameter> :</entry>
  75. <entry> The pattern height.
  76. </entry></row>
  77. <row><entry align="right"><parameter>mask_bpp</parameter> :</entry>
  78. <entry> Pattern bytes per pixel.
  79. </entry></row>
  80. <row><entry align="right"><parameter>length</parameter> :</entry>
  81. <entry> Length of pattern mask data.
  82. </entry></row>
  83. <row><entry align="right"><parameter>mask_data</parameter> :</entry>
  84. <entry> The pattern mask data.
  85. </entry></row>
  86. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> The pattern name.
  87. </entry></row>
  88. </tbody></tgroup></informaltable></refsect2>
  89. <refsect2>
  90. <title><anchor id="gimp-patterns-popup">gimp_patterns_popup ()</title>
  91. <programlisting><link linkend="gboolean">gboolean</link>    gimp_patterns_popup             (<link linkend="gchar">gchar</link> *pattern_callback,
  92.                                              <link linkend="gchar">gchar</link> *popup_title,
  93.                                              <link linkend="gchar">gchar</link> *initial_pattern);</programlisting>
  94. <para>
  95. Invokes the Gimp pattern selection.
  96. </para>
  97. <para>
  98. This procedure popups the pattern selection dialog.</para>
  99. <para>
  100.  
  101. </para><informaltable pgwide=1 frame="none" role="params">
  102. <tgroup cols="2">
  103. <colspec colwidth="2*">
  104. <colspec colwidth="8*">
  105. <tbody>
  106. <row><entry align="right"><parameter>pattern_callback</parameter> :</entry>
  107. <entry> The callback PDB proc to call when pattern selection is made.
  108. </entry></row>
  109. <row><entry align="right"><parameter>popup_title</parameter> :</entry>
  110. <entry> Title to give the pattern popup window.
  111. </entry></row>
  112. <row><entry align="right"><parameter>initial_pattern</parameter> :</entry>
  113. <entry> The name of the pattern to set as the first selected.
  114. </entry></row>
  115. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
  116. </entry></row>
  117. </tbody></tgroup></informaltable></refsect2>
  118. <refsect2>
  119. <title><anchor id="gimp-patterns-close-popup">gimp_patterns_close_popup ()</title>
  120. <programlisting><link linkend="gboolean">gboolean</link>    gimp_patterns_close_popup       (<link linkend="gchar">gchar</link> *pattern_callback);</programlisting>
  121. <para>
  122. Popdown the Gimp pattern selection.
  123. </para>
  124. <para>
  125. This procedure closes an opened pattern selection dialog.</para>
  126. <para>
  127.  
  128. </para><informaltable pgwide=1 frame="none" role="params">
  129. <tgroup cols="2">
  130. <colspec colwidth="2*">
  131. <colspec colwidth="8*">
  132. <tbody>
  133. <row><entry align="right"><parameter>pattern_callback</parameter> :</entry>
  134. <entry> The name of the callback registered for this popup.
  135. </entry></row>
  136. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
  137. </entry></row>
  138. </tbody></tgroup></informaltable></refsect2>
  139. <refsect2>
  140. <title><anchor id="gimp-patterns-set-popup">gimp_patterns_set_popup ()</title>
  141. <programlisting><link linkend="gboolean">gboolean</link>    gimp_patterns_set_popup         (<link linkend="gchar">gchar</link> *pattern_callback,
  142.                                              <link linkend="gchar">gchar</link> *pattern_name);</programlisting>
  143. <para>
  144. Sets the current pattern selection in a popup.
  145. </para>
  146. <para>
  147. Sets the current pattern selection in a popup.</para>
  148. <para>
  149.  
  150. </para><informaltable pgwide=1 frame="none" role="params">
  151. <tgroup cols="2">
  152. <colspec colwidth="2*">
  153. <colspec colwidth="8*">
  154. <tbody>
  155. <row><entry align="right"><parameter>pattern_callback</parameter> :</entry>
  156. <entry> The name of the callback registered for this popup.
  157. </entry></row>
  158. <row><entry align="right"><parameter>pattern_name</parameter> :</entry>
  159. <entry> The name of the pattern to set as selected.
  160. </entry></row>
  161. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
  162. </entry></row>
  163. </tbody></tgroup></informaltable></refsect2>
  164.  
  165. </refsect1>
  166.  
  167.  
  168.  
  169.  
  170. </refentry>
  171.